Beta: Get information of a batch of documents Beta

Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice. This endpoint is not yet generally available. Please contact Glean support to enable this feature.

Tip: Refer to the Troubleshooting tutorial for more information.

SecurityBearerAuth
Request
path Parameters
datasource
required
string

The datasource to which the document belongs

Request Body schema: application/json; charset=UTF-8
required
required
Array of objects (DebugDocumentRequest)

Documents to fetch debug information for

Responses
200

OK

Response Schema: application/json; charset=UTF-8
Array of objects (DebugDocumentsResponseItem)

List of document ids/urls and their debug information

400

Bad Request

401

Not Authorized

post/debug/{datasource}/documents
Request samples
application/json; charset=UTF-8
{
  • "debugDocuments": [
    • {
      • "objectType": "Article",
      • "docId": "art123"
      }
    ]
}
Response samples
application/json; charset=UTF-8
{
  • "documentStatuses": [
    • {
      • "docId": "string",
      • "objectType": "string",
      • "debugInfo": {
        • "status": {
          • "uploadStatus": "UPLOADED",
          • "lastUploadedAt": "2021-08-06T17:58:01.000Z",
          • "indexingStatus": "INDEXED",
          • "lastIndexedAt": "2021-08-06T17:58:01.000Z"
          },
        • "uploadedPermissions": {
          • "allowedUsers": [
            • {
              • "email": "string",
              • "datasourceUserId": "string",
              • "name": "string"
              }
            ],
          • "allowedGroups": [
            • "string"
            ],
          • "allowedGroupIntersections": [
            • {
              • "requiredGroups": [
                • null
                ]
              }
            ],
          • "allowAnonymousAccess": true,
          • "allowAllDatasourceUsersAccess": true
          }
        }
      }
    ]
}